Add phoenix-protocol (phUSD staking)#2682
Open
gititGoro wants to merge 3 commits into
Open
Conversation
Single-pool adapter for the Phoenix Protocol phUSD staking contract on Ethereum. Computes USDC reward APY from rewardBalance/depletionDuration and reads the phUSD-emission APY directly from the contract's desiredAPYBps target. Prices phUSD via the Balancer V3 phUSD/sUSDS pool and the sUSDS ERC4626 conversion to USDS. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a new Phoenix Protocol APY adapter that derives phUSD price from a Balancer V3 pool (with ERC4626 sUSDS rate and $1 fallback), reads PHLIMBO staking state on-chain, and computes USDC-based and phUSD-based APY components returning TVL and reward metadata. ChangesPhoenix Protocol Staking Adapter
🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers:
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
The phoenix-protocol adapter exports pools: Test Suites: 1 passed, 1 total |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/adaptors/phoenix-protocol/index.js (1)
51-59: ⚖️ Poor tradeoffConsider BigInt arithmetic for precision.
Converting balances to
Number(lines 51-52) may lose precision for very large pool balances. JavaScriptNumberhas ~15-17 significant decimal digits, which could introduce small rounding errors for 18-decimal tokens with large supplies. For typical pool sizes this is acceptable, but using BigInt arithmetic would be more robust.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/adaptors/phoenix-protocol/index.js` around lines 51 - 59, The code currently converts balances and sharesToAssets to Number which can lose precision; instead parse balances (balances[idxSusds], balances[idxPhusd]) and sharesToAssets as BigInt, perform fixed-point arithmetic using a chosen SCALE (e.g., BigInt(1e18)) to preserve 18-decimal precision: compute phUsdPriceInSUsds = (sUsdsBalance * SCALE) / phUsdBalance and compute usdsPerSUsds = (sharesToAssets * SCALE) / BigInt(1e18) (or equivalently keep shares scaled), then multiply and rescale to produce the final result; update the expressions that reference sUsdsBalance, phUsdBalance, sharesToAssets, phUsdPriceInSUsds, and usdsPerSUsds to use BigInt arithmetic and convert the final value to Number or string only at the return boundary.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/adaptors/phoenix-protocol/index.js`:
- Around line 37-38: The calls to callView using getPoolTokensAbi and
getCurrentLiveBalancesAbi pass BALANCER_POOL as a bare value; update these
invocations so the third argument is an array containing BALANCER_POOL (e.g.,
callView(BALANCER_VAULT, getPoolTokensAbi, [BALANCER_POOL]) and similarly for
getCurrentLiveBalancesAbi) to match the ABI parameter format used elsewhere and
avoid SDK runtime errors.
---
Nitpick comments:
In `@src/adaptors/phoenix-protocol/index.js`:
- Around line 51-59: The code currently converts balances and sharesToAssets to
Number which can lose precision; instead parse balances (balances[idxSusds],
balances[idxPhusd]) and sharesToAssets as BigInt, perform fixed-point arithmetic
using a chosen SCALE (e.g., BigInt(1e18)) to preserve 18-decimal precision:
compute phUsdPriceInSUsds = (sUsdsBalance * SCALE) / phUsdBalance and compute
usdsPerSUsds = (sharesToAssets * SCALE) / BigInt(1e18) (or equivalently keep
shares scaled), then multiply and rescale to produce the final result; update
the expressions that reference sUsdsBalance, phUsdBalance, sharesToAssets,
phUsdPriceInSUsds, and usdsPerSUsds to use BigInt arithmetic and convert the
final value to Number or string only at the return boundary.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8c4801dc-2662-4d40-9e9d-072218b0caac
📒 Files selected for processing (2)
src/adaptors/phoenix-protocol/README.mdsrc/adaptors/phoenix-protocol/index.js
Match the form already used by the convertToAssets call in the same function. The SDK accepts both bare and array forms, but mixing them is noisy. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The phoenix-protocol adapter exports pools: Test Suites: 1 passed, 1 total |
Author
|
Just checking in if there are any additional requirements before merge can happen |
The phUSD staking contract was redeployed to 0x6084a02c2ac0127ddf1e617de257c61480a2aee0. Point the adapter at the new address and document it in the README. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The phoenix-protocol adapter exports pools: Test Suites: 1 passed, 1 total |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a yield adapter for the Phoenix Protocol phUSD staking contract on Ethereum mainnet, exposing a single pool searchable as
phUSD.Pool
0x3984eBC84d45a889dDAc595d13dc0aC2E54819F4(phUSD staking)phUSDphoenix-protocolStakers deposit phUSD and receive two emission-based rewards.
APY methodology
rewardBalance / depletionDurationis annualized and divided by USD TVL.desiredAPYBpstarget. Computed directly asdesiredAPYBps / 100(currently0; will activate when governance enables it).apyRewardis the sum of the two;apyBaseisnull(the staking action itself produces no organic yield).Pricing
phUSD is priced from the Balancer V3 phUSD/sUSDS 50/50 weighted pool:
getPoolTokens+getCurrentLiveBalances(both tokens 18-dec, no rate provider).phUsdPriceInSUsds = sUsdsBalance / phUsdBalance.convertToAssets(1e18)live exchange rate.$1.Falls back to
$1peg with a warning if any of the on-chain reads fail.USDC is hardcoded to
$1.Test plan
npm run test --adapter=phoenix-protocol— 11/11 passing.symbol === 'phUSD', sane TVL (~$11.5k at time of writing).🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation